Get a User via ID

{ getUser }

Get a user via the User's system ID.

Method

/API2/access/getUser

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Input Parameters

    Name

    userId

    Type

    string

    Description

    The system user ID

    Output Response

    Successful Result Code

    200

    Response Type

    PyramidViewUserObject

    Description of Response Type

    The user object contains all relevant meta-data for the user.

    Notes

    The user object can be used in other operations where it is required. Use methods like 'getUsersByName' to find relevant user ID's